Upi Number Delink/SyncPending Callback

This callback is used for two purposes:

Purpose 1) This callback will be sent when a 10 digit UPI Number (Mobile Number) has been delinked from a particular Vpa and moved to a different PSP. In this case, action is PORTED_OUT and upiNumber will be 10 digit always.

Purpose 2) Juspay will asynchronously resolve UPI numbers that go to pending status, which happens when create or update UPI number call times out because of timeout at NPCI's end. When such a resolution to terminal status happens, this callback will be sent to the merchant using which merchant shall update/sync their database. In this case, action will be one of CREATE, REACTIVATE, CHANGE_VPA, DISABLE, DELETE and upiNumber can be 8, 9 or 10 digit.

Important notes about optional parameters and more:

1) In the first (current) version of UPI number feature, Juspay does not store the action and upiRequestId passed by merchant in create and update UPI number APIs. Hence Juspay will not be able to retrieve these values. So the equivalent action and gatewayTransactionId parameters shall NOT be passed for a bunch of UPI numbers. The status parameter will also be SUCCESS by default for this bunch of UPI numbers. (Applicable in Purpose 2)

2) upiNumberStatus will NOT be sent whenever action is PORTED_OUT. (Applicable in Purpose 1)

3) status will be SUCCESS when the action has succeeded and FAILURE if the action has failed.

Scroll inside to view more
Parameter
Description
action (optional)
Purpose of the callback, values possible are PORTED_OUT, CREATE, REACTIVATE, CHANGE_VPA, DISABLE, DELETE.
customResponse
Stringified JSON parameter for future use.
customerMobileNumber
Mobile number of the customer.
gatewayTimestamp
Timestamp of when the callback was initiated. (YYYY-MM-DDTHH:MM:SS+05:30)
gatewayTransactionId (optional)
UPI request id returned by gateway for the transaction.
merchantChannelId
Unique id for the channel via which request is made.
merchantCustomerId
Merchant generated unique id for customer.
merchantId
Unique id for merchant.
status
Status/Result of the action, values could be SUCCESS, FAILURE.
type
A unique key to identify the Upi Mapper feature, value is UPI_NUMBER_MAPPER.
upiNumber
Numeric 8-9 digits or 10 digits Mobile Number.
upiNumberStatus (optional)
Current terminal status of the UPI number after resolution. ACTIVE, DISABLED, DELETED.
vpa
Vpa linked to the upiNumber.